Add blog post on service web API changes #2758
Conversation
📝 WalkthroughWalkthroughA new documentation file was added to describe the removal of action translations from WebSocket get_services and REST /api/services responses due to incomplete translations, with instructions for fetching translations via frontend/get_translations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro Cache: Disabled due to data retention organization setting Knowledge base: Disabled due to data retention organization setting 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
blog/2025-08-20-service-web-api-changes.md (5)
4-4: Prefer “WebSocket” over “WS” in the title; tighten wording.Avoid unexplained abbreviations per Microsoft Style Guide and keep the title concise.
Apply this diff:
-title: "Service translations have been removed from WS get_services and REST /api/services" +title: "Service translations removed from WebSocket get_services and REST /api/services"
10-10: Clarify that inclusion is in the responses and align parallel structure.Be explicit that they remain in both responses, and mirror WebSocket/REST phrasing.
Apply this diff:
-Legacy untranslated action descriptions and names specified in `services.yaml` are still included both in the WS command and REST endpoint. +Legacy, untranslated action names and descriptions from `services.yaml` remain in both the WebSocket and REST responses.
14-14: Use imperative tone and expand “WS” to “WebSocket”.Aligns with Microsoft Style Guide and keeps instructions direct.
Apply this diff:
-Complete action translations can instead be fetched with the WS command `frontend/get_translations`. +Fetch complete action translations with the WebSocket command `frontend/get_translations`.
16-16: Tighten sentence and resolve grammar flag.Shorten and remove “which”. The link context makes “core” clear.
Apply this diff:
-For more details, refer to the core [PR 147120](https://github.com/home-assistant/core/pull/147120) which implemented the change. +For details, see [core PR 147120](https://github.com/home-assistant/core/pull/147120).
7-16: Add effective version to help integrators plan.Readers need to know from which Home Assistant release this change applies. Consider adding a short sentence indicating the first release containing this change.
Proposed addition (after the first paragraph):
- This change takes effect in Home Assistant .
Reply with the target version and I can update the wording accordingly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
blog/2025-08-20-service-web-api-changes.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
*/**(html|markdown|md)
⚙️ CodeRabbit Configuration File
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
*/**(html|markdown|md): - Use bold to mark UI strings.
If "" are used to mark UI strings, replace them by bold.
Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Use sentence-style capitalization also in headings.
do not comment on HTML used for icons
Avoid flagging inline HTML for embedding videos in future reviews for this repository.
Files:
blog/2025-08-20-service-web-api-changes.md
🪛 LanguageTool
blog/2025-08-20-service-web-api-changes.md
[grammar] ~16-~16: There might be a mistake here.
Context: ...ll/147120) which implemented the change.
(QB_NEW_EN)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
blog/2025-08-20-service-web-api-changes.md (2)
9-9: Expand “WS”, fix parallelism, and use consistent wording (“defined”).Follow earlier feedback to expand “WS” and align phrasing with Line 7.
-Legacy untranslated action descriptions and names specified in `services.yaml` are still included both in the WS command and REST endpoint. +Legacy untranslated action descriptions and names defined in `services.yaml` are still included in both the WebSocket command and the REST endpoint.
11-11: Expand “WS” and switch to directive style per Microsoft Style Guide.Use imperative mood and explicit terminology.
-Complete action translations can instead be fetched with the WS command `frontend/get_translations`. +Fetch complete action translations using the WebSocket `frontend/get_translations` command.
🧹 Nitpick comments (3)
blog/2025-08-20-service-web-api-changes.md (3)
4-4: Expand “WS” to “WebSocket” and use active voice in title.Use explicit terminology in titles and prefer active voice for brevity and clarity.
-title: "Service translations have been removed from WS get_services and REST /api/services" +title: "Service translations removed from WebSocket get_services and REST /api/services"
7-7: Minor clarity and tense tweak for readability.Keep present tense for ongoing truths and place the primary rationale first.
-Action translations defined in `strings.json` are no longer included in responses from the WebSocket `get_services` command and the REST `/api/services` endpoint because they were incomplete and the Home Assistant frontend did not use them. +Action translations defined in `strings.json` are no longer included in responses from the WebSocket `get_services` command and the REST `/api/services` endpoint because the Home Assistant frontend does not use them and the translations were incomplete.
13-13: Use “See … for details.” and remove nonessential clause.Improves style and also addresses the grammar hint from LanguageTool.
-For more details, refer to the core [PR 147120](https://github.com/home-assistant/core/pull/147120) which implemented the change. +See core [PR 147120](https://github.com/home-assistant/core/pull/147120) for details.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
blog/2025-08-20-service-web-api-changes.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
*/**(html|markdown|md)
⚙️ CodeRabbit Configuration File
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
*/**(html|markdown|md): - Use bold to mark UI strings.
If "" are used to mark UI strings, replace them by bold.
Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Use sentence-style capitalization also in headings.
do not comment on HTML used for icons
Avoid flagging inline HTML for embedding videos in future reviews for this repository.
Files:
blog/2025-08-20-service-web-api-changes.md
🪛 LanguageTool
blog/2025-08-20-service-web-api-changes.md
[grammar] ~13-~13: There might be a mistake here.
Context: ...ll/147120) which implemented the change.
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
🔇 Additional comments (1)
blog/2025-08-20-service-web-api-changes.md (1)
2-3: No changes needed:authorURLis the standard key
All existing blog posts useauthorURL:(no occurrences ofauthor_url:), including this one.
Proposed change
Add blog post on service web API changes
Type of change
Checklist
Additional information
Summary by CodeRabbit